Skip to main content

Lấy danh sách thành viên trong cuộc hội thoại

HTTP Request

GET https://{app_id}.api.piscale.com/open-api/v1.0/chat/threads/{thread_id}/members

Parameters

TênKiểu dữ liệuMô tảBắt buộc
thread_idstringMã cuộc hội thoại

Request header

Bảng mô tả tham số của request header:

TênKiểu dữ liệuMô tảBắt buộc
X-Api-KeystringAPI Key của ứng dụng
X-Tenant-IdstringChỉ định tenant của thread

Query

TênKiểu dữ liệuMô tảBắt buộc
last_member_idstringMã thành viên.
member_id_typenumber1: ext_user_id của PiScale
2: user_id của khách hàng đã đồng bộ
limitnumberGiới hạn số lượng thành viên. Tối đa 100 thành viên.
statusstringall: Lấy tất cả thành viên
active: Chỉ lấy những thành viên đang hoạt động
removed: Chỉ lấy những thành viên bị xóa
muted: Chỉ lấy những thành viên không có quyền gửi tin nhắn
banned: Chỉ lấy những thành viên bị xóa và chặn
note

Dữ liệu trả về sẽ được sắp xếp theo ext_user_id tăng dần.
Để lấy dữ liệu của trang tiếp theo vui lòng truyền last_member_id tương ứng với id của phần tử cuối cùng trong mảng dữ liệu trả về.

Response

Nếu thành công, bạn sẽ nhận được phản hồi.

Ví dụ
{
"message_code": "M200",
"message": "Thành công",
"data": [
{
"user_id": "49918031",
"ext_user_id": "6872016393206737",
"display_name" : "Andrew. Ng",
"avatar_url": "https://avatar-api.communi.io/a05b8b2d-a657-4f1c-965b-8ba94b91c20b/1b00a38d-cf83-41d4-9d59-e651836d21ff.png",
"status": "active",
"role": "owner",
},
{
"user_id": "49918032",
"ext_user_id": "6872016393206738",
"display_name" : "And. Ng",
"avatar_url": "https://avatar-api.communi.io/a05b8b2d-a657-4f1c-965b-8ba94b91c20b/1b00a38d-cf83-41d4-9d59-e651836d21ff.png",
"status": "banned",
"role": "member",
}
],
}
TênKiểu dữ liệuMô tả
message_codestringMã thông điệp. Xem chi tiết
messagestringNội dung mã thông điệp
data[i].user_idstringUser id phía khách hàng đã đồng bộ
data[i].ext_user_idstringUser id thuộc hệ thống của Piscale
data[i].display_namestringTên hiển thị
data[i].avatar_urlstringẢnh đại diện của user
data[i].statusstringactive, banned, removed, muted
data[i].rolestringowner, admin, member